/*
 * Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package org.netbeans.jemmy.drivers;

import org.netbeans.jemmy.Timeout;
import org.netbeans.jemmy.operators.ComponentOperator;

/**
 * Defines how to simulate keyboard operations.
 */
public interface KeyDriver {

    /**
     * Presses a key.
     *
     * @param oper Component operator.
     * @param keyCode Key code ({@code KeyEvent.VK_*} value)
     * @param modifiers a combination of {@code InputEvent.*_MASK} fields.
     */
    public void pressKey(ComponentOperator oper, int keyCode, int modifiers);

    /**
     * Typed a key.
     *
     * @param oper Component operator.
     * @param keyChar Symbol to be typed.
     * @param modifiers a combination of {@code InputEvent.*_MASK} fields.
     */
    public void typedKey(ComponentOperator oper, int keyCode, char keyChar, int modifiers);

    /**
     * Releases a key.
     *
     * @param oper Component operator.
     * @param keyCode Key code ({@code KeyEvent.VK_*} value)
     * @param modifiers a combination of {@code InputEvent.*_MASK} fields.
     */
    public void releaseKey(ComponentOperator oper, int keyCode, int modifiers);

    /**
     * Pushes a key.
     *
     * @param oper Component operator.
     * @param keyCode Key code ({@code KeyEvent.VK_*} value)
     * @param modifiers a combination of {@code InputEvent.*_MASK} fields.
     * @param pushTime Time between pressing and releasing.
     */
    public void pushKey(ComponentOperator oper, int keyCode, int modifiers, Timeout pushTime);

    /**
     * Types a symbol.
     *
     * @param oper Component operator.
     * @param keyCode Key code ({@code KeyEvent.VK_*} value)
     * @param keyChar Symbol to be typed.
     * @param modifiers a combination of {@code InputEvent.*_MASK} fields.
     * @param pushTime Time between pressing and releasing.
     */
    public void typeKey(ComponentOperator oper, int keyCode, char keyChar, int modifiers, Timeout pushTime);
}
